home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / cat3 / GetOption.3 < prev    next >
Text File  |  1994-09-20  |  2KB  |  67 lines
  1.  
  2.  
  3.  
  4. Tk_GetOption(3)       Tk Library Procedures
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      Tk_GetOption - retrieve an option from the option database
  12.  
  13. SYNOPSIS
  14.      #include <tk.h>
  15.  
  16.      Tk_Uid
  17.      Tk_GetOption(_t_k_w_i_n, _n_a_m_e, _c_l_a_s_s)
  18.  
  19. ARGUMENTS
  20.      Tk_Window   _t_k_w_i_n    (in)      Token for window.
  21.  
  22.      char        *_n_a_m_e    (in)      Name of desired option.
  23.  
  24.      char        *_c_l_a_s_s   (in)      Class  of   desired   option.
  25.                                     Null  means there is no class
  26.                                     for this option;   do  lookup
  27.                                     based on name only.
  28. _________________________________________________________________
  29.  
  30.  
  31. DESCRIPTION
  32.      This procedure is invoked to retrieve  an  option  from  the
  33.      database  associated  with _t_k_w_i_n's main window.  If there is
  34.      an option for _t_k_w_i_n that matches the given  _n_a_m_e  or  _c_l_a_s_s,
  35.      then  it  is  returned in the form of a Tk_Uid.  If multiple
  36.      options match _n_a_m_e and _c_l_a_s_s, then the highest-priority  one
  37.      is returned.  If no option matches, then NULL is returned.
  38.  
  39.      Tk_GetOption caches options related to _t_k_w_i_n so that succes-
  40.      sive calls for the same _t_k_w_i_n will execute much more quickly
  41.      than successive calls for different windows.
  42.  
  43.  
  44. KEYWORDS
  45.      class, name, option, retrieve
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.